docs: update publishing guide with Category and Effect columns#1913
docs: update publishing guide with Category and Effect columns#1913imviancagrace wants to merge 2 commits intogithub:mainfrom
Conversation
The README table now has Category and Effect columns (added in github#1897), but the publishing guide template still showed the old 3-column format. Update to match so extension authors know to include both fields. Made-with: Cursor
There was a problem hiding this comment.
Pull request overview
Updates the extension publishing guide template to reflect the newer community extension table format by documenting the added Category and Effect columns.
Changes:
- Updates the example table row in
EXTENSION-PUBLISHING-GUIDE.mdto include Category and Effect columns. - Adds definitions for allowed Category values and Effect values to guide extension authors.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (1)
extensions/EXTENSION-PUBLISHING-GUIDE.md:226
- Formatting is inconsistent in this template block:
Categoryuses an inline-code placeholder (<category>) whileEffectuses a plain<effect>, and the Effect options aren’t formatted as code like the Category values. Consider using consistent inline-code formatting for placeholders and for the allowed values (and optionally label the section as “(Table) Effect” to match “(Table) Category”) so it’s clear what text should be copied verbatim into the README table.
| Your Extension Name | Brief description of what it does | `<category>` | <effect> | [repo-name](https://github.com/your-org/spec-kit-your-extension) |
(Table) Category — pick the one that best fits your extension:
docs— reads, validates, or generates spec artifactscode— reviews, validates, or modifies source codeprocess— orchestrates workflow across phasesintegration— syncs with external platformsvisibility— reports on project health or progress
Effect — choose one:
- Read-only — produces reports without modifying files
- Read+Write — modifies files, creates artifacts, or updates specs
</details>
---
💡 <a href="/github/spec-kit/new/main?filename=.github/instructions/*.instructions.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add Copilot custom instructions</a> for smarter, more guided reviews. <a href="https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn how to get started</a>.
| ```markdown | ||
| | Your Extension Name | Brief description of what it does | [repo-name](https://github.com/your-org/spec-kit-your-extension) | | ||
| | Your Extension Name | Brief description of what it does | `<category>` | <effect> | [repo-name](https://github.com/your-org/spec-kit-your-extension) | | ||
| ``` |
There was a problem hiding this comment.
The example row here includes Category and Effect columns, but the current extensions/README.md “Available Community Extensions” table still has three columns (Extension | Purpose | URL). This guide should match the actual README table format, or the README needs to be updated in the same PR/rebased onto the change that adds those columns, otherwise extension authors will be told to submit a row that won’t fit the table.
This issue also appears on line 212 of the same file.
Description
Follow-up to #1897. The README table now has Category and Effect columns, but the publishing guide template still showed the old 3-column format. This updates the example row and adds descriptions of each Category and Effect value so extension authors know what to include.
Testing
N/A — documentation-only change.
AI Disclosure
Used Cursor (Claude) to apply the same column update from #1897 to the publishing guide. All content reviewed by the author.
Made with Cursor